CLI Examples

The following examples illustrate how to use the command-line interface.

Running a Project and Updating the Express project file

The following example runs the C:\Projects\MyProject.wrp project and updates MyProject.wrp with the new styles, conditions, variables and xrefs:

WebWorks.Automap.exe –u "C:\Projects\MyProject.wrp"

Running a Project and Generating Only One Target

The following example runs the C:\Projects\MyProject.wrp project and generates only the WebWorks Help target:

WebWorks.Automap.exe –t "WebWorks Help" "C:\Projects\MyProject.wrp"

Running a Project from Scratch and Deploying to a Clean Location

The following example runs the C:\Projects\MyProject.wrp project and generates all targets defined in the project. This example also deletes the cached information in ePublisher to ensure it generates all the content from scratch, and it deletes all the files in the deployment location before deploying the newly-generated files:

WebWorks.Automap.exe --clean --cleandeploy "C:\Projects\MyProject.wrp"

Running a Project and Deploying to an Alternate Location

The following example runs the C:\Projects\MyProject.wrp project and generates all targets defined in the project. This example also deploys all the newly generated files to the \\TestServer\Review folder:

WebWorks.Automap.exe -d "\\TestServer\Review" "C:\Projects\MyProject.wrp"

Running a Job Without Sending Notification When Done

The following example runs the C:\Jobs\MyJob.waj job and does not send any email notification when the job is done:

WebWorks.Automap.exe --nonotify "C:\Jobs\MyJob.waj"

Running a Job and Deploying to a Clean Location

The following example runs the C:\Jobs\MyJob.waj job and deletes all the files in the deployment location before deploying the newly-generated files:

WebWorks.Automap.exe --cleandeploy "C:\Jobs\MyJob.waj"

Running a Job Without Deploying the Content

The following example runs the C:\Jobs\MyJob.waj job and does not deploy the generated output files. This example also uses the C:\Temp\Stage folder as the staging folder when running the job:

WebWorks.Automap.exe --nodeploy -s "C:\Temp\Stage" "C:\Jobs\MyJob.waj"

The staging folder provides a working folder for processing the job. ePublisher AutoMap stores the automatically generated ePublisher project, intermediate data files, and the output files in this folder.

Rehearsing a Deployment Before Publishing

Deploying to a live location is hard to take back, so you can rehearse a run first. The following example runs the C:\Jobs\MyJob.waj job and rehearses its deployment instead of performing it:

WebWorks.Automap.exe --dryrun "C:\Jobs\MyJob.waj"

The job generates output exactly as it normally would. What changes is what happens at the end: an Amazon S3 destination reports the files it would upload, the files it would remove, and the invalidation it would issue, and it contacts AWS for none of it. A destination whose deployment type cannot rehearse a deployment does not deploy at all in this run, and the log says so rather than leaving you to notice. Read the log afterward, and when it describes the run you intended, run the job again without the option.

A composition rehearses the same way, and one command covers the whole publication:

WebWorks.Automap.exe --dryrun "C:\Jobs\ProductDocs\ProductDocs.wacj"

The composition passes the option down to every member it builds, so those member deployments are rehearsed too. Against a destination that is not an Amazon S3 destination, the composition also leaves the site at the destination alone instead of assembling it in place, so nothing that is already published changes.

The Two Dry Run Settings

Two separate settings can make a deployment dry, and they combine rather than cancel out:

The destination's own Dry run setting

Stored with the Amazon S3 destination itself, so it survives from run to run and applies to everyone and everything that deploys to that destination. Use it while you are still setting a destination up, or to keep a destination from being published to by accident. For more information, see Creating Output Destinations.

The --dryrun command-line option

Applies to one run and to every deployment in it, whatever the destinations themselves say. Use it to rehearse a job or a composition that normally publishes for real, without changing anything the destination stores.

There is no opposite option. A destination whose Dry run setting is selected cannot be forced to publish from the command line; clear the setting on the destination instead. For more information about the option, see CLI Syntax and Reference.